feat: support slack cli commands with composite action inputs by zimeg · Pull Request #560 · slackapi/slack-github-action

zimeg · 2026-02-25T05:23:15Z

Summary

This PR adds support for running Slack CLI commands with this GitHub action:

- uses: slackapi/slack-github-action/cli@v2
  with:
    command: "version"
    version: "3.14.0"

- uses: slackapi/slack-github-action/cli@v2
  with:
    command: "deploy --app ${{ vars.SLACK_APP_ID }} --force"
    token: ${{ secrets.SLACK_SERVICE_TOKEN }}

Follows earlier efforts and explorations of @ewanek1 in #486 #488 #489 👾 ✨

Includes

An optional version option to pin the installation to a specific version 🤖
An optional token option for authenticated commands
A required command option to run with the Slack CLI 🪩
Verbose logs when rerun in debug mode - Example logs 🔭
Examples of possible use patterns within kind preview 📚

Notes

The "nested" structure is recommendation of @WilliamBergamin and I find it makes inputs and outputs of this step much more clear for documentation sake! An earlier approach in ae50e2e demonstrates the "combined" setup.

Requirements

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

codecov · 2026-02-25T05:23:47Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.92%. Comparing base (3ffcfc3) to head (a76349b).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #560   +/-   ##
=======================================
  Coverage   95.92%   95.92%           
=======================================
  Files          14       14           
  Lines        2697     2697           
=======================================
  Hits         2587     2587           
  Misses        110      110

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

zimeg

🐙 Leaving notes for the wonderful reviewers after changes have become more stable in recent testing!

zimeg · 2026-02-28T23:50:52Z

.github/resources/README.md

+> **Note:** During CLI integration tests, `.github/resources/.slack` is moved to
+> `.slack` at the project root so the Slack CLI can discover the app manifest.


🔭 thought: This might be a limitation of the CLI at the moment. I think patterns exist elsewhere toward this, but I'm curious if an option in this action makes more sense...

-C <path> Run as if git was started in <path> instead of the current working directory.

zimeg · 2026-02-28T23:58:20Z

.github/workflows/publish.yml

+          include: |
+            dist/**/*
+            cli/**/*


📠 note: An example build shows both directories and adjacent files exist and work as expected!

📦 https://github.com/zimeg/slack-github-action/tree/v2.2.0-rc.1
🪵 https://github.com/zimeg/deno-github-functions/pull/1/checks

zimeg · 2026-03-01T01:20:30Z

example-workflows/Technique_4_Slack_CLI_Command/manifest.yml

zimeg · 2026-03-01T01:34:14Z

example-workflows/Technique_4_Slack_CLI_Command/deploy.yml

zimeg · 2026-03-01T01:41:39Z

example-workflows/Technique_4_Slack_CLI_Command/collaborators.yml

.github/workflows/integration.yml

zimeg · 2026-03-01T02:03:20Z

cli/action.yml

+    - name: Cache Slack CLI
+      if: steps.slack-cli-check.outputs.exists != 'true' && inputs.version != ''
+      id: cache-cli
+      uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
+      with:
+        path: |
+          ${{ runner.os == 'Windows' && '~/AppData/Local/slack-cli' || '~/.slack/bin' }}
+        key: slack-cli-${{ runner.os }}-${{ runner.arch }}-${{ inputs.version }}


👁️‍🗨️ note: We avoid caching when latest is used since a missing "version" input can cause stale installations. FWIW both a "clean" install and cached install are fast at around 4 seconds:

🔗 https://github.com/slackapi/slack-github-action/actions/runs/22533375996/job/65276385295#step:3:27

Cache hit for: slack-cli-Linux-X64-3.14.0 Received 7465485 of 7465485 (100.0%), 7.5 MBs/sec Cache Size: ~7 MB (7465485 B)

zimeg · 2026-03-01T02:11:58Z

action.yml

+name: "Slack GitHub Action"
 author: "slackapi"
 description: "Send data to Slack to start a Slack workflow in Workflow Builder, call a Slack API method, or post a message into a channel"


📣 note: We're renaming this action to match the project name and be more generic of the techniques available. This updates the marketplace page from what I understand. The link might change but I don't believe that must be static. Heads up though!

📚 question: Should we update the description alongside these changes? This might also appear on the marketplace page.

💡 thought: I didn't change it since the techniques served with these inputs are noted here while the CLI is included in separate configurations. Earlier discussion more with @WilliamBergamin hint that we might deprecate the top-level action for:

- slackapi/slack-github-action/api@v3 - slackapi/slack-github-action/bot@v3 - slackapi/slack-github-action/cli@v3 - slackapi/slack-github-action/wfb@v3

But we don't have immediate plans for this.

The "bot" technique also might not be true - it's meant for sending messages with incoming webhooks - but the patterns seem best for separate inputs more! I do think we can still package this action using this same action.yml file.

I think it would make sense to update the description if it appears on the Marketplace. The current description doesn't give you the full picture of what's possible now!

@mwbrooks I appreciate these suggestions as always - it's a good call! In 16992d6 we made the following change but I'm open to more updates ongoing, as always: 📸

zimeg · 2026-03-01T02:20:30Z

.github/workflows/integration.yml

-          codecov_token: ${{ secrets.CODECOV_API_TOKEN }}
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          extension: js
-          include: src


🔏 note: This is also removed in #559 but status checks are being reported as error for forked branches at this time.

srtaalej

⭐ ⭐ ⭐ tested the workflow against an app and everything worked smoothly!

srtaalej · 2026-03-03T21:59:12Z

docs/sending-techniques/running-slack-cli-commands/running-slack-cli-commands.md

+### Validate the app manifest
+
+```yaml
+steps:
+  - uses: actions/checkout@v4
+  - uses: slackapi/slack-github-action/cli@v2
+    with:
+      command: "manifest validate --app ${{ vars.SLACK_APP_ID }}"
+      token: ${{ secrets.SLACK_SERVICE_TOKEN }}
+```
+
+### Deploy an app with a service token
+
+```yaml
+steps:
+  - uses: actions/checkout@v4
+  - uses: slackapi/slack-github-action/cli@v2
+    with:
+      command: "deploy --app ${{ vars.SLACK_APP_ID }} --force"
+      token: ${{ secrets.SLACK_SERVICE_TOKEN }}
+```
+


srtaalej · 2026-03-10T19:41:18Z

docs/sending-techniques/running-slack-cli-commands/running-slack-cli-commands.md

+
+| Output     | Type      | Description                                                                             |
+| ---------- | --------- | --------------------------------------------------------------------------------------- |
+| `ok`       | `boolean` | If the command completed with a `0` exit code.                                          |
+| `response` | `string`  | The standard output from the CLI command.                                               |
+| `time`     | `number`  | The Unix [epoch time](https://en.wikipedia.org/wiki/Unix_time) that the step completed. |


mwbrooks

👏🏻 Amazing pull request @zimeg! It's so cool to see the Slack CLI available through our GitHub Action. I'm excited to see what folks do with it.

✅ Throwing a big approval on this PR!

💬 Left a minor, non-blocking comment to bump the description while we're at it.

mwbrooks · 2026-03-11T04:27:46Z

.github/resources/.slack/config.json

+  "manifest": {
+    "source": "local"
+  },
  "project_id": "c4805b41-d1ce-4ea0-b297-ed2f8c64c267"


question: Is project_id replaced when the GitHub Action runs? Or, will all GitHub Actions runs use the same global project ID?

@mwbrooks Ooh curious ask! I reran the workflow in debug mode to find out 🐛 🔍

[2026-03-11 05:46:04] project_id: c4805b41-d1ce-4ea0-b297-ed2f8c64c267

🔗 https://github.com/slackapi/slack-github-action/actions/runs/22938681409/job/66575655999?pr=560#step:8:261

IMO this is good to find since this project is being reused but please let me know if this should be changing in tests?

mwbrooks · 2026-03-11T04:35:18Z

action.yml

+name: "Slack GitHub Action"
 author: "slackapi"
 description: "Send data to Slack to start a Slack workflow in Workflow Builder, call a Slack API method, or post a message into a channel"


I think it would make sense to update the description if it appears on the Marketplace. The current description doesn't give you the full picture of what's possible now!

…ublic (#561)

zimeg added 2 commits February 24, 2026 20:33

feat: cli

ae50e2e

feat: cli

165d9f6

zimeg requested a review from WilliamBergamin February 25, 2026 05:23

zimeg self-assigned this Feb 25, 2026

zimeg added enhancement New feature or request semver:minor labels Feb 25, 2026

zimeg temporarily deployed to staging February 25, 2026 05:23 — with GitHub Actions Inactive

fix: echo output

2d8c996

zimeg temporarily deployed to staging February 25, 2026 05:27 — with GitHub Actions Inactive

ci: use development build

077f882

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

zimeg temporarily deployed to staging February 25, 2026 07:00 — with GitHub Actions Inactive

fix: add to windows path

35b8102

zimeg temporarily deployed to staging February 25, 2026 08:06 — with GitHub Actions Inactive

ci: remove feature build cli version

5d5197b

zimeg temporarily deployed to staging February 25, 2026 08:17 — with GitHub Actions Inactive

test: verbose version

613ab73

zimeg temporarily deployed to staging February 25, 2026 08:39 — with GitHub Actions Inactive

fix: run windows build in powershell

47ed37c

zimeg temporarily deployed to staging February 25, 2026 08:42 — with GitHub Actions Inactive

ci: dev

4e7d5d3

zimeg temporarily deployed to staging February 25, 2026 09:07 — with GitHub Actions Inactive

ci: debug

f50140b

zimeg temporarily deployed to staging February 25, 2026 09:11 — with GitHub Actions Inactive

ci: tee output

b48e5cf

zimeg temporarily deployed to staging February 25, 2026 09:15 — with GitHub Actions Inactive

test: write empty credentials for windows tests for io speed

32371dd

zimeg temporarily deployed to staging February 25, 2026 09:33 — with GitHub Actions Inactive

test: attempt to create all windows files or quit

059f8f3

zimeg temporarily deployed to staging February 25, 2026 09:47 — with GitHub Actions Inactive

zimeg temporarily deployed to staging February 28, 2026 03:19 — with GitHub Actions Inactive

zimeg added 2 commits February 27, 2026 19:42

chore: merge w main

069243d

docs: example

5d9cb89

zimeg temporarily deployed to staging February 28, 2026 04:25 — with GitHub Actions Inactive

zimeg added 2 commits February 27, 2026 20:34

docs: redirect

ae9124d

docs: versions

4aab456

zimeg temporarily deployed to staging February 28, 2026 04:37 — with GitHub Actions Inactive

zimeg and others added 8 commits February 28, 2026 14:42

docs: recommend more focused best practices

2d9b061

docs: rebrand without 'send'

03b6946

build: cache to globbed directories

638743f

docs: extend links in github readmes

671d51b

docs: fix examples

1003081

build: skip cache when no version is pinned

22fc69b

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

docs: add errors to message posting examples

cba9656

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

docs: fallback to real name when display name is empty

4500857

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

zimeg mentioned this pull request Mar 1, 2026

test: use the latest cli release in tests after the next release is public #561

Merged

2 tasks

zimeg commented Mar 1, 2026

View reviewed changes

Merge branch 'main' into cli

e29bb10

srtaalej approved these changes Mar 10, 2026

View reviewed changes

mwbrooks approved these changes Mar 11, 2026

View reviewed changes

zimeg added 3 commits March 10, 2026 22:43

test: use the latest cli release in tests after the next release is p…

398c562

…ublic (#561)

docs: update marketplace description of action

16992d6

Merge branch 'cli' of github.com:slackapi/slack-github-action into cli

a76349b

		> Note: During CLI integration tests, `.github/resources/.slack` is moved to
		> `.slack` at the project root so the Slack CLI can discover the app manifest.

Conversation

zimeg commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Includes

Notes

Requirements

Uh oh!

codecov bot commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srtaalej left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mwbrooks left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

zimeg commented Feb 25, 2026 •

edited

Loading

codecov bot commented Feb 25, 2026 •

edited

Loading